Vcenter VmTemplate LibraryItems DeploySpec
The Vcenter VmTemplate LibraryItems DeploySpec schema defines the deployment parameters that can be specified for the deploy operation.
This schema was added in vSphere API 6.8.
{
"name": "string",
"description": "string",
"vm_home_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"disk_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"disk_storage_overrides": {
"disk_storage_overrides": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
}
},
"placement": {
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string"
},
"powered_on": false,
"guest_customization": {
"name": "string"
},
"hardware_customization": {
"nics": {
"nics": {
"network": "string"
}
},
"disks_to_remove": [
"string"
],
"disks_to_update": {
"disks_to_update": {
"capacity": 0
}
},
"cpu_update": {
"num_cpus": 0,
"num_cores_per_socket": 0
},
"memory_update": {
"memory": 0
}
}
}Name of the deployed virtual machine.
This property was added in vSphere API 6.8.
Description of the deployed virtual machine.
This property was added in vSphere API 6.8.
If missing or null, the deployed virtual machine has the same description as the source library item.
Storage location for the deployed virtual machine's configuration and log files.
This property was added in vSphere API 6.8.
If missing or null, the deployed virtual machine's configuration and log files are created with the same storage spec as the source virtual machine template's configuration and log files.
Storage specification for the deployed virtual machine's disks.
This property was added in vSphere API 6.8.
If both disk_storage_overrides and disk_storage are missing or null, the deployed virtual machine's disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.
If disk_storage_overrides is missing or null and disk_storage is specified, all of the deployed virtual machine's disks are created with the storage spec specified by disk_storage.
If disk_storage_overrides is specified and disk_storage is missing or null, disks with identifiers that are not in disk_storage_overrides are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.
If both disk_storage_overrides and disk_storage are specified, disks with identifiers that are not in disk_storage_overrides are created with the storage spec specified by disk_storage.
Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications.
This property was added in vSphere API 6.8.
If both disk_storage_overrides and disk_storage are missing or null, the deployed virtual machine's disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.
If disk_storage_overrides is missing or null and disk_storage is specified, all of the deployed virtual machine's disks are created with the storage spec specified by disk_storage.
If disk_storage_overrides is specified and disk_storage is missing or null, disks with identifiers that are not in disk_storage_overrides are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.
If both disk_storage_overrides and disk_storage are specified, disks with identifiers that are not in disk_storage_overrides are created with the storage spec specified by disk_storage.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
Information used to place the deployed virtual machine.
This property was added in vSphere API 6.8.
This property is currently required. In the future, if this property is missing or null, the system will use the values from the source virtual machine template contained in the library item.
If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.
Specifies whether the deployed virtual machine should be powered on after deployment.
This property was added in vSphere API 6.8.
If missing or null, the virtual machine will not be powered on after deployment.
Guest customization spec to apply to the deployed virtual machine.
This property was added in vSphere API 6.8.
If missing or null, the guest operating system is not customized after deployment.
Hardware customization spec which specifies updates to the deployed virtual machine.
This property was added in vSphere API 6.8.
If missing or null, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item.